﻿#region License

// Created by John Batte on 04/03/2012 at 3:03 PM.
// Last code cleanup: 04/04/2012 at 11:05 AM.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

#endregion

using System;
using System.IO;
using System.Reflection;

namespace BatteCode.Google.Wiki
{
	/// <summary>
	/// 	Defines a wiki writer.
	/// </summary>
	public interface IWikiWriter
	{
		/// <summary>
		/// 	Gets or sets the root directory.
		/// </summary>
		/// <value> The root directory. </value>
		string RootDirectory{ get; set; }

		/// <summary>
		/// 	Gets or sets the status output writer.
		/// </summary>
		/// <value> The status output writer. </value>
		TextWriter StatusOutput{ get; set; }

		/// <summary>
		/// 	Gets the observable status updates.
		/// </summary>
		IObservable<WikiStatus> StatusUpdates{ get; }

		/// <summary>
		/// 	Writes the specified member using the provided text.
		/// </summary>
		/// <param name="member"> The member. </param>
		/// <param name="text"> The text. </param>
		void Write(MemberInfo member, string text);
	}
}